home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / macros / text1 / cms_help_files / enf.helpmark < prev    next >
Text File  |  1991-10-23  |  6KB  |  130 lines
  1. +-----------------------------------------------------------------------------+
  2. |                                endnoteformat                                |
  3. +-----------------------------------------------------------------------------+
  4.  
  5. \endnoteformat{\skipbefore{4pt}
  6.         \textreferenceposition{down}
  7.         \textreferencefont{\rm}
  8.         \textreferencestyle{[1]}
  9.         \notereferenceposition{down}
  10.         \notereferencefont{\tenpt}
  11.         \notereferencestyle{1.}
  12.         \notereferencegutter{1em}
  13.         \everyendnote{\tenpt\pin{0pt}\lin{1.2em}}}
  14.  
  15. Abbreviation:  π|\enfπ%
  16.  
  17. Parameters:    π|submarkupπ%
  18.  
  19. Submarkup:     π|\skipbefore, \textreferenceposition,
  20. \textreferencefont, \textreferencestyle, \notereferenceposition, \noterefer-
  21. encefont, \notereferencestyle, \notereferencegutter, \everyendnoteπ%
  22.  
  23.     π|Description:π%
  24. The \endnoteformat markup allows you to modify the shape and presentation of
  25. endnotes generated with \autoendnote.
  26.  
  27. \skipbefore   indicates how much  space is to  be skipped  before printing a
  28. block.  This amount is in addition to any paragraph skips.
  29.  
  30. \textreferenceposition    determines  if  the  endnote reference  number  is
  31. superscripted or not.   By default, the reference is  not superscripted.  If
  32. you want the  endnote reference number to be  superscripted, then change the
  33. parameter to "up".
  34.  
  35. \textreferencefont   lets  you change  the face  or size.    By  default the
  36. endnote reference number is always printed in the standard font.
  37.  
  38. \textreferencestyle  determines the numbering  style at the end of a chapter
  39. or the end of the document (wherever the \printendnotes appears).  There are
  40. five possible values:
  41.   1. "1" for numbered endnotes
  42.   2. "(1)" for numbered endnotes with parentheses
  43.   3. "[1]" for numbered endnotes with square brackets
  44.   4. "a" for lettered endnotes
  45.   5. "(a)" for lettered endnotes with parentheses
  46. The default is Arabic numerals in square brackets.
  47.  
  48. \notereferenceposition    determines  if  the  endnote reference  number  is
  49. superscripted or not when  it is printed at the end  of a chapter or the end
  50. of a document.  By default, the reference is not superscripted.  If you want
  51. the endnote reference number  to be superscripted, then change the parameter
  52. to "up".
  53.  
  54. \notereferencefont   lets  you change  the face  or size.    By  default the
  55. endnote  reference number  printed at  the end  of a  chapter  (or end  of a
  56. document, wherever \printendnotes occurs)  is always printed in the standard
  57. font.
  58.  
  59. \notereferencestyle    determines the  numbering  style.     There are  five
  60. possible values:
  61.   1. "1."  for numbered endnotes
  62.   2. "(1)" for numbered endnotes with parentheses
  63.   3. "[1]" for numbered endnotes with square brackets
  64.   4. "a" for lettered endnotes
  65.   5. "(a)" for lettered endnotes with parentheses
  66. The default is numbered endnotes.
  67.  
  68. \notereferencegutter   specifies  the amount  of  space between  the endnote
  69. number and the endnote  text.  The gutter is  illustrated here as the shaded
  70. portion between "1."  and "The first step":
  71. +-----------------------------------------------------------------------------+
  72. |                                                                             |
  73. |       ...                                                                   |
  74. |     1....The first step . . .                                               |
  75. |                                                                             |
  76. +-----------------------------------------------------------------------------+
  77.  
  78. \everyendnote  lets you  modify the shape of the notes.   You can change the
  79. type face, the paragraph parameters, and the right and left indentation.
  80.  
  81.     π|Example:π%
  82. This example shows an endnote style with a superscripted endnote number; the
  83. body of the endnote in a 9 point Computer Modern set; the endnote at the end
  84. of the document (or chapter) indented half an inch from the left and half an
  85. inch from the  right of the rest of  the body of the  text; the endnote body
  86. right ragged; and  the text of the document right  justified and in 10 point
  87.  
  88. Computer Modern.   The  endnote "text" reference  at the end  of the chapter
  89. will retain the default style ("1."  not superscripted).
  90.     Note that 9 point  was specified within both the "notereferencefont" and
  91. "everyendnote" markups.   The  "notereferencefont" determines  the font that
  92. the endnote reference number is to be printed in.  The "everyendnote" markup
  93. determines the font that  the endnote text is to print  in at the end of the
  94. document or end of chapter, wherever the next \printendnotes markup appears.
  95.  
  96. \endnoteformat{\skipbefore{12pt}
  97.          \textreferenceposition{up}
  98.          \textreferencefont{\ninepoint\rm}
  99.          \textreferencestyle{1}
  100.          \notereferenceposition{down}
  101.          \notereferencefont{\ninepoint\rm}
  102.          \notereferencestyle{1.}
  103.          \everyendnote{\rightragged
  104.            \pin{0pt}\psk{12pt}\ninepoint
  105.            \leftindent{.5in}\rightindent{.5in}}
  106.           }
  107.  
  108.  
  109. | . .   automatically sets an interline skip 2 points greater                 |
  110. than the font size.\autoendnote{This extra space is
  111. referred to as leading.} The default font size is  . . .
  112.  
  113. The endnote in the document would look like:
  114. +-----------------------------------------------------------------------------+
  115. |                                                                             |
  116. |  . . .     automatically sets an interline  skip 2 points greater than the  |
  117. | font size.  The default font size is  . . .                                 |
  118. |                                                                             |
  119. +-----------------------------------------------------------------------------+
  120. The endnote printed after the \printendnotes markup would look like:
  121. +-----------------------------------------------------------------------------+
  122. |                                                                             |
  123. |     1.  This extra space is referred to as leading.                         |
  124. |                                                                             |
  125. +-----------------------------------------------------------------------------+
  126.  
  127.     π|Notes:π%
  128. The \endnoteformat markup must come after the \monospace markup, if both are
  129. used.
  130.